home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / SLIDEBOX.HDR < prev    next >
Text File  |  1994-04-25  |  3KB  |  83 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _SlideBox( cDir, nTmax, nLMax, nBMax, nRMax, nType, cFill, lShadow ) --> NIL
  8.  
  9. PARAMETERS:
  10.  
  11. cDir    : Direction of "slide" U/D/L/R
  12. nTMax   : Top Row
  13. nLMax   : Left Column
  14. nBMax   : Bottom Row
  15. nRMax   : Right Column
  16. nType   : Type of Box Characters to use
  17. cFill   : Character to use to fill box (Default SPACE)
  18. lShadow : Logical TRUE  = Draw shadow after box (DEFAULT)
  19.                   FALSE = No Shadow
  20.  
  21. SHORT:
  22.  
  23. Displays a "sliding" exploding box from any direction (ala popbox()).
  24.  
  25. DESCRIPTION:
  26.  
  27. _SlideBox() "explodes" a box onto the screen starting at the top,
  28. bottom, left, or right of the box, (depending upon cDir) stopping at the
  29. given coordinates.  Optionally, you may specify the box characters.
  30. Default box is Double Top/Single Side.
  31.  
  32. NOTE:
  33.  
  34. Due to the different CPU speeds of various computers, the box may "explode"
  35. so fast as to be unnoticeable.  This can be controlled by use of a
  36. DOS environment variable
  37.  
  38. SET BOXDELAY=6000
  39.  
  40. Also, since the screen coordinate system is over three times wider than it
  41. is high, the verticle motion is complete much sooner than the
  42. horizontal motion.  This may be a desired effect (having the box quickly
  43. reach verticle limits and then panning horizontally for the remainder).
  44. If not, you can adjust it by setting a DOS environment variable
  45. called BOXRATIO.
  46.  
  47. SET BOXRATIO=3
  48.  
  49. A setting of 3 will cause the verticle and horizontal motion to end at
  50. almost the same time. A value greater than 4 will cause the horizontal
  51. motion to finish first and the remaining time will be spent completing
  52. the verticle motion.  A value less than four has the opposit effect.
  53.  
  54. These values are detected if present and used as a delay factor between
  55. each step of the "explosion" to slow the process down on fast computers,
  56. and delay the horizontal motion to match the verticle motion.
  57.  
  58. Do not use fractional numbers (non-integers) for the boxdelay variable.
  59. Doing so will result in occasional "escapes" of the box from it's
  60. final coordinates.  It will continue to explode further than desired.
  61.  
  62. Be aware of how the Boxratio is affected by the "evenness/oddness" of
  63. the total range of the final box coordinates and the fact that the
  64. screen columns are numbered 0-79.
  65.  
  66. A Box whose coordinates are an even number in terms of total range will have
  67. a starting center that is one to the left or right of center.  This means
  68. that one side will finish just slightly sooner than the other.
  69.  
  70. 5,5 to 12,75 = 70 total places to span.
  71. Half of 70 is 35.
  72.  
  73. In full speed motion, this trait is barely a flicker, and hardly noticeable.
  74. But on slower machines, it may look odd.
  75.  
  76. EXAMPLE:
  77.  
  78. _SlideBox('D',10,10,15,70)
  79.  
  80. Result:  A box is drawn, "sliding" DOWN from line 10 to line 15.
  81.  
  82. ******************************************************************************/
  83.